<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>phpDocumentor » \ActiveRecord\Expressions</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">phpDocumentor</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/ActiveRecord.html"><i class="icon-folder-open"></i> ActiveRecord</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">310</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">5</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">3</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method___construct" title="__construct :: "><span class="description">__construct()
        </span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_bind" title="bind :: Bind a value to the specific one based index."><span class="description">Bind a value to the specific one based index.</span><pre>bind()</pre></a></li>
<li class="method public "><a href="#method_bind_values" title="bind_values :: "><span class="description">bind_values()
        </span><pre>bind_values()</pre></a></li>
<li class="method public "><a href="#method_get_connection" title="get_connection :: Returns the connection object."><span class="description">Returns the connection object.</span><pre>get_connection()</pre></a></li>
<li class="method public "><a href="#method_set_connection" title="set_connection :: Sets the connection object."><span class="description">Sets the connection object.</span><pre>set_connection()</pre></a></li>
<li class="method public "><a href="#method_to_s" title="to_s :: "><span class="description">to_s()
        </span><pre>to_s()</pre></a></li>
<li class="method public "><a href="#method_values" title="values :: Returns all the values currently bound."><span class="description">Returns all the values currently bound.</span><pre>values()</pre></a></li>
</ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="method private "><a href="#method_build_sql_from_hash" title="build_sql_from_hash :: "><span class="description">build_sql_from_hash()
        </span><pre>build_sql_from_hash()</pre></a></li>
<li class="method private "><a href="#method_quote_string" title="quote_string :: "><span class="description">quote_string()
        </span><pre>quote_string()</pre></a></li>
<li class="method private "><a href="#method_stringify_value" title="stringify_value :: "><span class="description">stringify_value()
        </span><pre>stringify_value()</pre></a></li>
<li class="method private "><a href="#method_substitute" title="substitute :: "><span class="description">substitute()
        </span><pre>substitute()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties
                    <ul></ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="property private "><a href="#property_connection" title="$connection :: "><span class="description"></span><pre>$connection</pre></a></li>
<li class="property private "><a href="#property_expressions" title="$expressions :: "><span class="description"></span><pre>$expressions</pre></a></li>
<li class="property private "><a href="#property_values" title="$values :: "><span class="description"></span><pre>$values</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants
                    <ul><li class="constant  "><a href="#constant_ParameterMarker" title="ParameterMarker :: "><span class="description">ParameterMarker</span><pre>ParameterMarker</pre></a></li></ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\ActiveRecord\Expressions"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/ActiveRecord.html">ActiveRecord</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/ActiveRecord.Expressions.html">Expressions</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Templating like class for building SQL statements.</p>
<div class="details">
<div class="long_description"><p>Examples:
'name = :name AND author = :author'
'id = IN(:ids)'
'id IN(:subselect)'</p></div>
<table class="table table-bordered"><tr>
<th>package</th>
<td><a href="../packages/ActiveRecord.html">ActiveRecord</a></td>
</tr></table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>__construct()
        </h2>
<pre>__construct($connection, $expressions) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$connection</h4></div>
<div class="subelement argument"><h4>$expressions</h4></div>
</div></div>
</div>
<a id="method_bind"></a><div class="element clickable method public method_bind" data-toggle="collapse" data-target=".method_bind .collapse">
<h2>Bind a value to the specific one based index.</h2>
<pre>bind($parameter_number, $value) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>There must be a bind marker
for each value bound or to_s() will throw an exception.</p></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$parameter_number</h4></div>
<div class="subelement argument"><h4>$value</h4></div>
</div></div>
</div>
<a id="method_bind_values"></a><div class="element clickable method public method_bind_values" data-toggle="collapse" data-target=".method_bind_values .collapse">
<h2>bind_values()
        </h2>
<pre>bind_values($values) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$values</h4></div>
</div></div>
</div>
<a id="method_get_connection"></a><div class="element clickable method public method_get_connection" data-toggle="collapse" data-target=".method_get_connection .collapse">
<h2>Returns the connection object.</h2>
<pre>get_connection() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_set_connection"></a><div class="element clickable method public method_set_connection" data-toggle="collapse" data-target=".method_set_connection .collapse">
<h2>Sets the connection object.</h2>
<pre>set_connection(string $connection) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>It is highly recommended to set this so we can
use the adapter's native escaping mechanism.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$connection</h4>
<code>string</code><p>a Connection instance</p></div>
</div></div>
</div>
<a id="method_to_s"></a><div class="element clickable method public method_to_s" data-toggle="collapse" data-target=".method_to_s .collapse">
<h2>to_s()
        </h2>
<pre>to_s($substitute, $options) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$substitute</h4></div>
<div class="subelement argument"><h4>$options</h4></div>
</div></div>
</div>
<a id="method_values"></a><div class="element clickable method public method_values" data-toggle="collapse" data-target=".method_values .collapse">
<h2>Returns all the values currently bound.</h2>
<pre>values() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_build_sql_from_hash"></a><div class="element clickable method private method_build_sql_from_hash" data-toggle="collapse" data-target=".method_build_sql_from_hash .collapse">
<h2>build_sql_from_hash()
        </h2>
<pre>build_sql_from_hash($hash, $glue) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$hash</h4></div>
<div class="subelement argument"><h4>$glue</h4></div>
</div></div>
</div>
<a id="method_quote_string"></a><div class="element clickable method private method_quote_string" data-toggle="collapse" data-target=".method_quote_string .collapse">
<h2>quote_string()
        </h2>
<pre>quote_string($value) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$value</h4></div>
</div></div>
</div>
<a id="method_stringify_value"></a><div class="element clickable method private method_stringify_value" data-toggle="collapse" data-target=".method_stringify_value .collapse">
<h2>stringify_value()
        </h2>
<pre>stringify_value($value) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$value</h4></div>
</div></div>
</div>
<a id="method_substitute"></a><div class="element clickable method private method_substitute" data-toggle="collapse" data-target=".method_substitute .collapse">
<h2>substitute()
        </h2>
<pre>substitute($values, $substitute, $pos, $parameter_index) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$values</h4></div>
<div class="subelement argument"><h4>$substitute</h4></div>
<div class="subelement argument"><h4>$pos</h4></div>
<div class="subelement argument"><h4>$parameter_index</h4></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a id="property_connection"> </a><div class="element clickable property private property_connection" data-toggle="collapse" data-target=".property_connection .collapse">
<h2></h2>
<pre>$connection </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_expressions"> </a><div class="element clickable property private property_expressions" data-toggle="collapse" data-target=".property_expressions .collapse">
<h2></h2>
<pre>$expressions </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_values"> </a><div class="element clickable property private property_values" data-toggle="collapse" data-target=".property_values .collapse">
<h2></h2>
<pre>$values </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a id="constant_ParameterMarker"> </a><div class="element clickable constant  constant_ParameterMarker" data-toggle="collapse" data-target=".constant_ParameterMarker .collapse">
<h2>ParameterMarker</h2>
<pre>ParameterMarker </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
            generated on 2013-06-08T13:56:19-04:30.<br></footer></div>
</div>
</body>
</html>
